Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix solhint rules and adjusted GlacisFacet test file #1043

Merged
merged 2 commits into from
Mar 5, 2025
Merged

Fix solhint rules and adjusted GlacisFacet test file #1043

merged 2 commits into from
Mar 5, 2025

Conversation

mirooon
Copy link
Contributor

@mirooon mirooon commented Mar 5, 2025

Which Jira task belongs to this PR?

Why did I implement it this way?

Disabled the no-empty-blocks rule to apply test files where some testBase_ tests need to be empty (examples: testBase_CanSwapAndBridgeNativeTokens, testBase_CanBridgeNativeTokens). Second solution: adding // solhint-disable-next-line no-empty-blocks to each test could be cumbersome to maintain.

Checklist before requesting a review

Checklist for reviewer (DO NOT DEPLOY and contracts BEFORE CHECKING THIS!!!)

  • I have checked that any arbitrary calls to external contracts are validated and or restricted
  • I have checked that any privileged calls (i.e. storage modifications) are validated and or restricted
  • I have ensured that any new contracts have had AT A MINIMUM 1 preliminary audit conducted on by <company/auditor>

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 5, 2025 •
edited
Loading

Walkthrough

This pull request disables the Solidity lint rule for empty blocks by changing its configuration in the .solhint.json file. In addition, it renames a variable in the Solidity test file and updates the Solidity version specification, ensuring consistency across declarations without altering functionality.

Changes

File(s) Summary
.solhint.json Changed "no-empty-blocks": "error" to "no-empty-blocks": "off", disabling the lint rule for empty blocks.
test/solidity/Facets/GlacisFacet.t.sol Renamed variable from ADDRESS_SRC_TOKEN to addressSrcToken and updated the Solidity version from pragma solidity 0.8.17; to ^0.8.17;.

Possibly related PRs

Suggested labels

AuditNotRequired

Suggested reviewers

  • ezynda3
  • 0xDEnYO

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)
  • JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b45e479 and ab560b2.

📒 Files selected for processing (2)
  • .solhint.json (1 hunks)
  • test/solidity/Facets/GlacisFacet.t.sol (12 hunks)
🧰 Additional context used
🪛 Gitleaks (8.21.2)
test/solidity/Facets/GlacisFacet.t.sol

446-446: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

462-462: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: run-unit-tests
  • GitHub Check: enforce-min-test-coverage
🔇 Additional comments (6)
.solhint.json (1)

14-14: Rule update aligns with PR objective and improves test maintenance.

Disabling the no-empty-blocks rule makes sense for the stated PR purpose of accommodating test files with empty block implementations like testBase_CanSwapAndBridgeNativeTokens. This change eliminates the need to add individual disable comments throughout the test files, making the codebase more maintainable.

test/solidity/Facets/GlacisFacet.t.sol (5)

2-2: Good Solidity versioning update.

Changing from a fixed version to a compatible range (^0.8.17) allows for minor version updates without requiring changes to the pragma directive, while still ensuring compatibility with the minimum required version.

30-30: Consistent naming convention change.

Renaming the variable from ADDRESS_SRC_TOKEN to addressSrcToken improves consistency with the codebase's naming conventions for internal variables. This is the first occurrence of the renamed variable.

39-39: Thorough and consistent rename implementation.

The renaming of ADDRESS_SRC_TOKEN to addressSrcToken has been consistently applied across all occurrences in the file. This ensures that the code continues to function properly after the change.

Also applies to: 44-45, 77-78, 87-88, 163-164, 167-168, 229-230, 241-242, 261-263, 285-286, 446-447, 462-463

446-447: False positive on token addresses.

The static analysis tool flagged these token addresses as potential API keys, but these are actually valid ERC20 token addresses on their respective networks (W token on Arbitrum and LINK token on Base), not credentials.

Also applies to: 462-463

🧰 Tools
🪛 Gitleaks (8.21.2)

446-446: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.

(generic-api-key)

154-156: Empty block implementation now allowed by linting rules.

These test methods with empty blocks were likely the reason for disabling the no-empty-blocks rule in the Solhint configuration. The change allows these test overrides to exist without needing individual disable comments.

Also applies to: 220-222

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@lifi-action-bot lifi-action-bot marked this pull request as draft March 5, 2025 13:14
@lifi-action-bot
Copy link
Collaborator

Test Coverage Report

Line Coverage: 78.59% (2041 / 2597 lines)
Function Coverage: 83.72% ( 355 / 424 functions)
Branch Coverage: 44.57% ( 226 / 507 branches)
Test coverage (78.59%) is above min threshold (76%). Check passed.

@mirooon mirooon marked this pull request as ready for review March 5, 2025 13:23
@mirooon mirooon enabled auto-merge March 5, 2025 13:26
@mirooon mirooon merged commit c6f83d4 into main Mar 5, 2025
26 checks passed
@mirooon mirooon deleted the fix-glacisfacet-test-file-solhint branch March 5, 2025 13:37
@coderabbitai coderabbitai bot mentioned this pull request Mar 5, 2025
Closed
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@0xDEnYO 0xDEnYO 0xDEnYO approved these changes

Assignees
No one assigned
Labels
AuditNotRequired
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mirooon @lifi-action-bot @0xDEnYO